This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class VolumeInformation | |||||||||
| class, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Detailed information on Mac volumes. | |||||||||
Blocksize as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The size of an allocation block, in bytes. | |||||||||
|
Notes:
This field is only appropriate for volume formats (such as HFS and HFS Plus) that allocate space in fixed-size pieces; other volume formats may not have a similar concept, and may set this field to zero. | |||||||||
DataForkClumpSize as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Default data fork clump size. | |||||||||
|
Notes:
When a fork is automatically grown as it is written, the File Manager attempts to allocate space that is a multiple of the clump size. This field is zero for volume formats that don’t support the notion of a clump size. | |||||||||
DefaultVolume as boolean | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Is this the default volume? | |||||||||
DriveNumber as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The drive number for the drive (drive queue element) associated with the volume. | |||||||||
DriverRefNum as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The driver reference number for the drive (drive queue element) associated with the volume. | |||||||||
FileCount as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The total number of files on the volume, or 0 if unknown. | |||||||||
FilesOpen as boolean | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Are there files open on this volume? | |||||||||
|
Notes:
For the boot volume false!? | |||||||||
FileSystemID as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Identifies the filesystem implementation that is handling the volume; this is zero for HFS and HFS Plus volumes. | |||||||||
FolderCount as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The total number of folders on the volume, or 0 if unknown. Note that no root directory counts. | |||||||||
freeBlocks as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The number of unused allocation blocks on the volume. | |||||||||
|
Notes:
This field is only appropriate for volume formats (such as HFS and HFS Plus) that allocate space in fixed-size pieces; other volume formats may not have a similar concept, and may set this field to zero. | |||||||||
Freebytes as double | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The number of bytes of free space on the volume. | |||||||||
HardwareLocked as boolean | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
is the volume locked by hardware? | |||||||||
Name as String | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The name of the volume. | |||||||||
|
Notes:
The name is in Unicode. RB 4.5 should know how to handle that. | |||||||||
NextAllocation as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
A hint for where to start searching for free space during an allocation. | |||||||||
|
Notes:
This field is only appropriate for volume formats (such as HFS and HFS Plus) that allocate space in fixed-size pieces; other volume formats may not have a similar concept, and may set this field to zero. | |||||||||
NextAllocation as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The next unused catalog node ID. | |||||||||
|
Notes:
Some volume formats (such as HFS and HFS Plus) use a monotonically increasing number for the catalog node ID (i.e. File ID or Directory ID) of newly created files and directories. For those volume formats, the nextCatalogID is the next file/directory ID that will be assigned. For other volume formats, this field will be zero. | |||||||||
ResourceForkClumpSize as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
Default resource fork clump size. | |||||||||
|
Notes:
When a fork is automatically grown as it is written, the File Manager attempts to allocate space that is a multiple of the clump size. This field is zero for volume formats that don’t support the notion of a clump size. | |||||||||
Root as Folderitem | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
A folderitem to the root of this volume. | |||||||||
Signature as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
This field is used to distinguish between volume formats supported by a single filesystem implementation. | |||||||||
|
Notes:
Example values:
| |||||||||
SoftwareLocked as boolean | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
is the volume locked by software? | |||||||||
Totalblocks as integer | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The total number of allocation blocks on the volume. | |||||||||
|
Notes:
This field is only appropriate for volume formats (such as HFS and HFS Plus) that allocate space in fixed-size pieces; other volume formats may not have a similar concept, and may set this field to zero. | |||||||||
Totalbytes as double | |||||||||
| property, Volume Information | Mo, 15. Jul 2002 | ||||||||
| Mac OS Classic: Works. | Mac OS Carbon: Works. | Windows: does nothing. | |||||||
|
Function:
The size of the volume in bytes. | |||||||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.